<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.calculation</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;calculation
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.calculation-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module calculation</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#acoustic_response" class="summary-sig-name">acoustic_response</a>(<span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">frequency</span>)</span><br />
      Calculates the acoustic response based on acoustic rays already 
      generated using the rays object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#acoustic_response">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#adjacencies" class="summary-sig-name">adjacencies</a>(<span class="summary-sig-arg">sampleSize</span>,
        <span class="summary-sig-arg">shading</span>,
        <span class="summary-sig-arg">ignore</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Calculates inter-zonal adjacencies for all currently visible zones.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#adjacencies">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#comfort" class="summary-sig-name">comfort</a>()</span><br />
      Use this command to (re)calculate mean radiant temperatures and 
      thermal comfort values if you have an a visible analysis grid set up 
      within a valid thermal model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#comfort">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#insolation_1" class="summary-sig-name">insolation_1</a>(<span class="summary-sig-arg">target</span>,
        <span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">select3D</span>,
        <span class="summary-sig-arg">accumulation</span>,
        <span class="summary-sig-arg">metric</span>=<span class="summary-sig-default">None</span>)</span><br />
      Calculates incident solar radiation levels (insolation) over either 
      the current analysis grid or objects within the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#insolation_1">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#insolation_2" class="summary-sig-name">insolation_2</a>(<span class="summary-sig-arg">period</span>,
        <span class="summary-sig-arg">shading</span>,
        <span class="summary-sig-arg">ground</span>,
        <span class="summary-sig-arg">direct</span>)</span><br />
      Calculates resource consumption within the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#insolation_2">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#lighting" class="summary-sig-name">lighting</a>(<span class="summary-sig-arg">target</span>,
        <span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">select3D</span>,
        <span class="summary-sig-arg">comparison</span>=<span class="summary-sig-default">0</span>)</span><br />
      Calculates daylight factors and lighting levels over either the 
      current analysis grid or POINT objects within the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#lighting">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#resources" class="summary-sig-name">resources</a>(<span class="summary-sig-arg">type</span>)</span><br />
      Calculates resource consumption within the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#resources">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#shading_percentage" class="summary-sig-name">shading_percentage</a>(<span class="summary-sig-arg">cumulative</span>,
        <span class="summary-sig-arg">startDay</span>,
        <span class="summary-sig-arg">stopDay</span>,
        <span class="summary-sig-arg">startTime</span>,
        <span class="summary-sig-arg">stopTime</span>,
        <span class="summary-sig-arg">shadingType</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">percentage</code><code class="variable-quote">'</code></span>)</span><br />
      Calculates the shading mask for the currently selected object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#shading_percentage">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#thermal_temperatures" class="summary-sig-name">thermal_temperatures</a>(<span class="summary-sig-arg">calc_type</span>,
        <span class="summary-sig-arg">zone</span>=<span class="summary-sig-default">0</span>)</span><br />
      Use these methods to invoke thermal calculations.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#thermal_temperatures">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#volumes" class="summary-sig-name">volumes</a>()</span><br />
      Calculates zone volumes for all currently visible zones.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#volumes">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#get_dates" class="summary-sig-name">get_dates</a>()</span><br />
      Retrieves the range of dates used for calculations.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_dates">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#set_dates" class="summary-sig-name">set_dates</a>(<span class="summary-sig-arg">startDay</span>,
        <span class="summary-sig-arg">stopDay</span>,
        <span class="summary-sig-arg">incDay</span>=<span class="summary-sig-default">1</span>)</span><br />
      Sets the range of dates used for calculations.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_dates">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#get_precision" class="summary-sig-name">get_precision</a>()</span><br />
      Retrieves the level of precision used in lighting calculations for 
      the calc.lighting command.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_precision">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#set_precision" class="summary-sig-name">set_precision</a>(<span class="summary-sig-arg">precision</span>)</span><br />
      Sets the precision of lighting calculations to be used with the calc.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_precision">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#get_sky" class="summary-sig-name">get_sky</a>()</span><br />
      Retrieves the type of sky illuminance distribution and design sky 
      illuminance level used during daylight calculations.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_sky">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#set_material_default" class="summary-sig-name">set_material_default</a>(<span class="summary-sig-arg">sky</span>,
        <span class="summary-sig-arg">level</span>)</span><br />
      Set this property to make the specified material the default for all 
      new objects of the same element type.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_material_default">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#get_times" class="summary-sig-name">get_times</a>()</span><br />
      Retrieves the range of times used for calculations.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_times">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#set_times" class="summary-sig-name">set_times</a>(<span class="summary-sig-arg">startDay</span>,
        <span class="summary-sig-arg">stopDay</span>,
        <span class="summary-sig-arg">incDay</span>=<span class="summary-sig-default">1</span>)</span><br />
      Sets the range of times used for calculations.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_times">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#get_window_cond" class="summary-sig-name">get_window_cond</a>()</span><br />
      Gets the window conditions for lighting calculations using the 
      calc.lighting command.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_window_cond">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.calculation-module.html#set_window_cond" class="summary-sig-name">set_window_cond</a>(<span class="summary-sig-arg">cleanliness</span>)</span><br />
      Sets the precision of lighting calculations to be used with the 
      calc.lighting command.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_window_cond">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="acoustic_response"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">acoustic_response</span>(<span class="sig-arg">type</span>,
        <span class="sig-arg">frequency</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#acoustic_response">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates the acoustic response based on acoustic rays already 
  generated using the rays object.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>type This parameter is either 0 for a 'Estimated Reverberation' 
  calculation or 1 for a calculation based on 'Existing 
  Rays/Particles'.</p>
  <p>frequency The frequency parameter refers to the numeric values given 
  in the following</p>
  <p>Available Acoustic Frequencies table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Acoustic Frequencies Value Frequency 0 63 Hz 1 125 Hz 2 250 
  Hz 3 500 Hz 4 1000 Hz 5 2000 Hz 6 4000 Hz 7 8000 Hz 8 16000 Hz</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="adjacencies"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">adjacencies</span>(<span class="sig-arg">sampleSize</span>,
        <span class="sig-arg">shading</span>,
        <span class="sig-arg">ignore</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#adjacencies">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates inter-zonal adjacencies for all currently visible 
  zones.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>[ignore] If this optional string parameter is given instead of any 
  others, the requirement to recalculate inter-zonal adjacencies will be 
  ignored. This may be useful when you perform a zone-related operation 
  that you know will not affect overshadowing or the thermal validity of 
  spaces.</p>
  <p>sampleSize To deal with geometry of any level of complexity, ECOTECT 
  samples surfaces using pseudo-random points, each located somewhere 
  within a regular grid. Use this parameter to set the size of this grid 
  for each object in the default dimension units. Smaller sampling grid 
  values will result in more accurate adjacency calculations, but will 
  obviously take much longer to generate.</p>
  <p>shading [true|false] Set this parameter to 'true' to have the 
  calculation generate shading masks for each object. When set to 'false', 
  no masks are calculated and shading is ignored.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="comfort"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">comfort</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#comfort">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to (re)calculate mean radiant temperatures and 
  thermal comfort values if you have an a visible analysis grid set up 
  within a valid thermal model.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="insolation_1"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">insolation_1</span>(<span class="sig-arg">target</span>,
        <span class="sig-arg">type</span>,
        <span class="sig-arg">select3D</span>,
        <span class="sig-arg">accumulation</span>,
        <span class="sig-arg">metric</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#insolation_1">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates incident solar radiation levels (insolation) over either 
  the current analysis grid or objects within the model.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>target [grid|objects] This parameter determines whether the insolation
  calculation is performed over the analysis grid or over objects. It can 
  only have either the value 'grid' or 'objects'. Any other value will be 
  intepreted as 'grid'.</p>
  <p>type The type parameter sets the type of calculation to be performed, 
  as shown in the following insolation types table.</p>
  <p>select3D When calculating over the analysis grid, setting this boolean
  parameter to 'true' or 1 calculates insolation for the entire 3D volume 
  of the grid. Setting it to 'false' or 0 means just the current 2D slice. 
  When calculating over objects, setting this parameter to 'true' or 1 
  calculates insolation only for selected objects in the model. Setting it 
  to 'false' or 0 means all visible objects.</p>
  <p>accumulation Determines how to tabulate the results of the insolation 
  calculation, based on values in the following solar accumulation 
  table.</p>
  <p>[metric] This parameter must be given if the type parameter has been 
  set to reference. It determines the type of value to store as the 
  'before' reference, based on the following Insolation Metrics table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Insolation Calculations Token Value Description incidence 0 
  Incident Solar Radiation on Points &amp; Surfaces absorption 1 Solar 
  Absorbtion/Transmission of Object Surfaces skyfactor 2 Sky Factor &amp; 
  Photosynthetically Active Radiation shading 3 Shading, Overshadowing and 
  Sunlight Hours reference 4 COMPARE VALUE- Reference (Before) comparison 5
  COMPARE VALUE- Comparison (After)</p>
  <p>Available Insolation Accumulations Token Value Description cumulative 
  0 Cumulative daily 1 Average Daily hourly 2 Average Hourly peak 3 
  Peak</p>
  <p>Available Insolation Metrics Token Value Description incident 0 Total 
  Incident Radiation absorbed 1 Total Absorbed Radiation transmitted 2 
  Total Transmitted Radiation photosynthetic 3 Photosynth. Active Radiation
  shading 4 Avg Shading Percentage sunlight 5 Total Sunlight Hours sky 6 
  Total Visible Sky</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="insolation_2"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">insolation_2</span>(<span class="sig-arg">period</span>,
        <span class="sig-arg">shading</span>,
        <span class="sig-arg">ground</span>,
        <span class="sig-arg">direct</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#insolation_2">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates resource consumption within the model.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>period The type parameter sets the type of resource calculation to be 
  performed, as shown in the following Types of Solar Calculation Types 
  table.</p>
  <p>shading This parameter sets the type of accuracy of shading 
  calculations to be performed, as shown in the following Solar Shading 
  Accuracy table.</p>
  <p>ground Determines whether ground reflections are considered in the 
  calclation. This is a boolean value where 1 or true represents the 
  affirmative and 0 or false the negative.</p>
  <p>direct Determines whether only direct light is included in the solar 
  calculation. This is a boolean value where 1 or true represents the 
  affirmative and 0 or false the negative.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Types of Solar Calculation Token Description day Single day 
  radiation. average Average daily radiation. total Total monthly 
  radiation. full Full hourly radiation.</p>
  <p>Accuracy of Solar Calculations Value Description 0 Full - break object
  into 25x25 grid. 1 High - break object into 10x10 grid. 2 Medium - break 
  object into 5x5 grid. 3 Low - use single point at object centre.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="lighting"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">lighting</span>(<span class="sig-arg">target</span>,
        <span class="sig-arg">type</span>,
        <span class="sig-arg">select3D</span>,
        <span class="sig-arg">comparison</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#lighting">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates daylight factors and lighting levels over either the 
  current analysis grid or POINT objects within the model.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>target [grid|points] This parameter determines whether the lighting 
  calculation is performed over the analysis grid or over POINT objects. It
  can only have  either the value 'grid' or 'point'. Any other value will 
  be intepreted as grid'.</p>
  <p>type The type parameter sets the type of calculation to be performed, 
  as shown in the following Lighting Types table.</p>
  <p>select3D When calculating over the analysis grid, setting this boolean
  parameter to 'true' or 1 calculates lighting for the entire 3D volume of 
  the grid. Setting it to 'false' or 0 means just the current 2D slice. 
  When calculating over objects, setting this parameter to 'true' or 1 
  calculates lighting only for selected POINTs in the model. Setting it to 
  'false' or 0 means all visible POINTs.</p>
  <p>[comparison] The comparison parameter is optional and allows you to 
  compare before and after results, as outlined in the Lighting Comparison 
  following table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Lighting Calculations Token Value Description daylight 0 
  Natural Light - Daylight Factors &amp; Levels overall 1 Overall Light - 
  Daylight and Electric Levels compare 2 Comparison against previous 
  calculation</p>
  <p>Available Lighting Comparisons Value Description 0 Normal: Store 
  Calculated Values 1 Compare: After / Before - as a percentage (%) 2 
  Compare: Before / After - as a percentage (%) 3 Compare: After - Before 4
  Compare: Before - After</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="resources"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">resources</span>(<span class="sig-arg">type</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#resources">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates resource consumption within the model.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>type The type parameter sets the type of resource calculation to be 
  performed, as shown in the following resource calculation types 
  table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Resource Calculations Token Description energy Daily Energy 
  Use load Daily Load Matching solar Hourly Solar Collection electricity 
  Hourly Electricity Use water Hourly Water Use waste Hourly Waste Water 
  fueloil Hourly Fuel Oil Use kerosene Hourly Kerosene Use natgas Hourly 
  Nat. Gas Use lpgas Hourly LP Gas Use coal Hourly Coal Use</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="shading_percentage"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">shading_percentage</span>(<span class="sig-arg">cumulative</span>,
        <span class="sig-arg">startDay</span>,
        <span class="sig-arg">stopDay</span>,
        <span class="sig-arg">startTime</span>,
        <span class="sig-arg">stopTime</span>,
        <span class="sig-arg">shadingType</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">percentage</code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#shading_percentage">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates the shading mask for the currently selected object. The 
  command suffix refers to the shading information to be calculated, as 
  outlined in the following Available Shading Calculations table. The 
  optional parameters only apply to solar stress calculations. If not 
  included, these default to the full year (0-365) and all day (0-24).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>cumulative A boolean value determining if solar radiation should show 
  cumulative annual results rather than hourly total stress values.</p>
  <p>startDay The starting date for the calculation. This is a julian date,
  a number between 1 and 365.</p>
  <p>stopDay The end date for the calculation. This is a julian date, a 
  number between 1 and 365.</p>
  <p>startTime Determines the starting time for the calculation. This is a 
  decimal value between 0.00 and 23.99.</p>
  <p>stopTime Determines the end time for the calculation. This is a 
  decimal value between 0.00 and 23.99.</p>
  <p>shadingType Can be percentage, total, diffuse or direct. Default is 
  percentage</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Thermal Calculations Token Description temperatures Hourly 
  temperatures for current day. gains Hourly heat gains for current day. 
  loads Monthly heating and cooling loads. distribution Temperature 
  distribution. fabricgains Average monthly-hourly fabric heat flow. 
  indirectgains Average monthly-hourly indirect solar gains. directgains 
  Average monthly-hourly direct solar gains ventilationgains Average 
  monthly-hourly ventilation gains. internalgains Average monthly-hourly 
  internal gains. zonalgains Average monthly-hourly inter-zonal gains. 
  totalgains Average monthly-hourly total space gains. passivegains Passive
  gains breakdown. adaptability Passive adaptibility index. comparison 
  Temperature/gains comparison . degreedays Monthly degree days.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="thermal_temperatures"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">thermal_temperatures</span>(<span class="sig-arg">calc_type</span>,
        <span class="sig-arg">zone</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#thermal_temperatures">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use these methods to invoke thermal calculations. The command suffixes
  refer to the different thermal calculation types as shown in the 
  following Available Thermal Calculations table. Calculation types relate 
  directly to the Thermal Calculation selector in the Thermal Analysis tab 
  of the Graphical Results dialog.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>calc_type Refer to  the thermal calculations table below</p>
  <p>[zone] This optional parameter can be used to specify the zero-based 
  index of a zone to use for the calculation. This paramater only applies 
  to the .gains and ...gains calculations, and relates directly to the 
  Highlight Zone selector (however the zone index is always given as the 
  absolute index in the entire zone list).</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Thermal Calculations Token Description temperatures Hourly 
  temperatures for current day. gains Hourly heat gains for current day. 
  loads Monthly heating and cooling loads. distribution Temperature 
  distribution. fabricgains Average monthly-hourly fabric heat flow. 
  indirectgains Average monthly-hourly indirect solar gains. directgains 
  Average monthly-hourly direct solar gains ventilationgains Average 
  monthly-hourly ventilation gains. internalgains Average monthly-hourly 
  internal gains. zonalgains Average monthly-hourly inter-zonal gains. 
  totalgains Average monthly-hourly total space gains. passivegains Passive
  gains breakdown. adaptability Passive adaptibility index. comparison 
  Temperature/gains comparison . degreedays Monthly degree days.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="volumes"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">volumes</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#volumes">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates zone volumes for all currently visible zones.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_dates"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_dates</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_dates">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the range of dates used for calculations. Up to three values
  are returned, being the startDay, the stopDay, and the optional [incDay],
  which determines if the start and stop days are inclusive of the date 
  range.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>startDay The starting date for the calculation. This is a julian date,
  being a number between 1 and 365.</p>
  <p>stopDay The end date for the calculation. This is a julian date, being
  a number between 1 and 365.</p>
  <p>incDay a boolean result (0 or 1) indicating if the start and stop 
  dates are inclusive within the date range.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_dates"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_dates</span>(<span class="sig-arg">startDay</span>,
        <span class="sig-arg">stopDay</span>,
        <span class="sig-arg">incDay</span>=<span class="sig-default">1</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_dates">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the range of dates used for calculations.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>startDay The starting date for the calculation. This is a julian date,
  a number between 1 and 365.</p>
  <p>stopDay The end date for the calculation. This is a julian date, a 
  number between 1 and 365.</p>
  <p>[incDay] An optional boolean parameter (0 or 1) that determines if the
  start and stop dates are inclusive of the date range.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_precision"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_precision</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_precision">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the level of precision used in lighting calculations for the
  calc.lighting command.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>precision An integer value corresponding to one of the items in the 
  following Calculation Precision table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Calculation Precisions Token Value Description full 0 Full 
  Precision veryhigh 1 Very High Precision high 2 High Precision medium 3 
  Medium Precision low 4 Low Precision</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_precision"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_precision</span>(<span class="sig-arg">precision</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_precision">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the precision of lighting calculations to be used with the calc. 
  lighting command.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>precision Determines the calculation accuracy by controlling the 
  number of test rays sprayed from each test point, according to the 
  following table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Calculation Precisions Token Value Description full 0 Full 
  Precision veryhigh 1 Very High Precision high 2 High Precision medium 3 
  Medium Precision low 4 Low Precision</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_sky"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_sky</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_sky">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the type of sky illuminance distribution and design sky 
  illuminance level used during daylight calculations.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>sky An integer value or token taken from the following Sky Types 
  table.</p>
  <p>level The design sky illuminance level in Lux.</p>
  <p>Relevant Data Table(s) Available Sky Types Token Value Description 
  overcast 0 CIE Overcast Sky uniform 1 CIE Uniform Sky</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_material_default"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_material_default</span>(<span class="sig-arg">sky</span>,
        <span class="sig-arg">level</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_material_default">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set this property to make the specified material the default for all 
  new objects of the same element type.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>sky An integer value or token taken from the following Sky Types 
  table.</p>
  <p>level The design sky illuminance level in Lux.</p>
  <p>Relevant Data Table(s) Available Sky Types Token Value Description 
  overcast 0 CIE Overcast Sky uniform 1 CIE Uniform Sky</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_times"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_times</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_times">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the range of times used for calculations. Up to three values
  are returned, being the startTime, the stopTime, and the optional 
  [incTime], which determines if the start and stop times are inclusive of 
  the time range.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>startTime The starting time for the calculation. This is a decimal 
  value between 0.00 and 23.99.</p>
  <p>stopTime The end time for the calculation. This is a decimal value 
  between 0.00 and  23.99.</p>
  <p>[incDay] A boolean value (0 or 1) indicating if the start and stop 
  times are inclusive of the date range.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_times"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_times</span>(<span class="sig-arg">startDay</span>,
        <span class="sig-arg">stopDay</span>,
        <span class="sig-arg">incDay</span>=<span class="sig-default">1</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_times">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the range of times used for calculations.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>startTime Determines the starting time for the calculation. This is a 
  decimal value between 0.00 and 23.99.</p>
  <p>stopTime Determines the end time for the calculation. This is a 
  decimal value between 0.00 and 23.99.</p>
  <p>[incDay] An optional boolean parameter (0 or 1) that determines if the
  start and stop times are inclusive of the date range.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_window_cond"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_window_cond</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#get_window_cond">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the window conditions for lighting calculations using the 
  calc.lighting command.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>cleanliness An index representing the average cleanliness of windows 
  in the model, as given in the following table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Window Cleanliness Values Value Description 0 Clean Windows (x 1.00) 1
  Average Windows (x 0.90) 2 Dirty Windows (x 0.75)</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_window_cond"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_window_cond</span>(<span class="sig-arg">cleanliness</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.calculation-pysrc.html#set_window_cond">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the precision of lighting calculations to be used with the 
  calc.lighting command.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>cleanliness An index representing the average cleanliness of windows 
  in the model, as given in the following table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Window Cleanliness Values Value Description 0 Clean Windows (x 1.00) 1
  Average Windows (x 0.90) 2 Dirty Windows (x 0.75)</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
